RealtimeService

Constructors

constructor(client: PocketbaseClient)

@Serializable

data class MessageData(val action: RealtimeService.RealtimeActionType, val record: JsonElement?)

The data sent when a realtime event is emitted

The type of realtime event emitted

Creates a realtime connection NOTE: There can only be one realtime connection going at once

suspend fun disconnect()

Disconnects from the current realtime session,closes all active listen coroutines and unsubscribes from all records.

Listens for subscribed realtime events asynchronously, when one is received callback is run

suspend fun subscribe(delay: Long = 2000, vararg subscriptionList: String)

suspend fun subscribe(subscription: String, delay: Long = 2000)

Creates a subscription to a record or collection allowing listen to received events from the desired target.

suspend fun unsubscribe(delay: Long = 2000, vararg subscriptionList: String)

Removes a subscriptions to a record or collection allowing listen to no longer receive events from the desired target.

suspend fun unsubscribe(subscription: String, delay: Long = 2000)

Removes a subscription to a record or collection allowing listen to no longer receive events from the desired target.

suspend fun unsubscribeAll(delay: Long = 2000)

Unsubscribes from every subscription, meaning the listen no longer receives events from any collection or record until one is subscribed to